thumbstick2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef THUMBSTICK2_H
#define THUMBSTICK2_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_pwm.h"




#define THUMBSTICK2_ADC_START_BIT               0x01
#define THUMBSTICK2_ADC_SINGLE_ENDED            0x80
#define THUMBSTICK2_ADC_CHANNEL_X               0x00
#define THUMBSTICK2_ADC_CHANNEL_Y               0x40
#define THUMBSTICK2_ADC_DATA_RESOLUTION         0x0FFF
#define THUMBSTICK2_ADC_DATA_RESOLUTION_HALF    ( ( float ) THUMBSTICK2_ADC_DATA_RESOLUTION / 2 )

#define THUMBSTICK2_RADIANS_TO_DEGREES          57.295779513
#define THUMBSTICK2_ANGLE_ZERO_OFFSET           180.0
#define THUMBSTICK2_PI_RAD_OFFSET               1.0
#define THUMBSTICK2_NEUTRAL_POSITION_OFFSET     ( ( float ) THUMBSTICK2_ADC_DATA_RESOLUTION / 8 )
#define THUMBSTICK2_FULL_ANGLE                  360.0f
#define THUMBSTICK2_ZERO_ANGLE                  0.0f
#define THUMBSTICK2_ANGLE_POSITION_STEP         45.0f

#define THUMBSTICK2_POSITION_NEUTRAL            0
#define THUMBSTICK2_POSITION_UP                 1
#define THUMBSTICK2_POSITION_UPPER_LEFT         2
#define THUMBSTICK2_POSITION_LEFT               3
#define THUMBSTICK2_POSITION_LOWER_LEFT         4
#define THUMBSTICK2_POSITION_DOWN               5
#define THUMBSTICK2_POSITION_LOWER_RIGHT        6
#define THUMBSTICK2_POSITION_RIGHT              7
#define THUMBSTICK2_POSITION_UPPER_RIGHT        8

#define THUMBSTICK2_PWM_DEF_FREQ                20000
#define THUMBSTICK2_PWM_MIN_DUTY                0.0
#define THUMBSTICK2_PWM_MAX_DUTY                1.0

#define THUMBSTICK2_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define THUMBSTICK2_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 // thumbstick2_set



#define THUMBSTICK2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.vb = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
 // thumbstick2_map // thumbstick2

typedef struct
{
    // Output pins
    digital_out_t vb;               
 
    // Input pins
    digital_in_t sw;                
 
    // Modules
    pwm_t pwm;                      
    spi_master_t spi;               
 
    pin_name_t chip_select;         
    uint32_t pwm_freq;              
 
} thumbstick2_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    pin_name_t vb;                  
 
    // Additional gpio pins
    pin_name_t sw;                  
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
    uint32_t dev_pwm_freq;          
 
} thumbstick2_cfg_t;

typedef enum
{
    THUMBSTICK2_OK = 0,
    THUMBSTICK2_ERROR = -1
 
} thumbstick2_return_value_t;


void thumbstick2_cfg_setup ( thumbstick2_cfg_t *cfg );

err_t thumbstick2_init ( thumbstick2_t *ctx, thumbstick2_cfg_t *cfg );

err_t thumbstick2_read_raw_adc ( thumbstick2_t *ctx, uint16_t *raw_x, uint16_t *raw_y );

float thumbstick2_get_angle ( uint16_t raw_x, uint16_t raw_y );

uint8_t thumbstick2_get_position ( uint16_t raw_x, uint16_t raw_y );

err_t thumbstick2_set_duty_cycle ( thumbstick2_t *ctx, float duty_cycle );

err_t thumbstick2_pwm_stop ( thumbstick2_t *ctx );

err_t thumbstick2_pwm_start ( thumbstick2_t *ctx );

uint8_t thumbstick2_get_sw_pin ( thumbstick2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THUMBSTICK2_H
 // thumbstick2
 
// ------------------------------------------------------------------------ END